<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Docs For Class DefaultUser</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" ><!-- Start of Class Data -->
<h2>
	Class DefaultUser
</h2> (line <span class="linenumber">36</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
</pre>
<p>
	<b><i>Located in File: <a href="_reference---DefaultUser.php.html">/reference/DefaultUser.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>Reference Implementation of the DefaultUser interface.</h5>
<ul>
		<li><strong>version:</strong> - Release: @package_version@</li>
		<li><strong>copyright:</strong> - 2009-2010 The OWASP Foundation</li>
		<li><strong>link:</strong> - <a href="http://www.owasp.org/index.php/ESAPI">http://www.owasp.org/index.php/ESAPI</a></li>
		<li><strong>license:</strong> - <a href="http://www.opensource.org/licenses/bsd-license.php">New BSD license</a></li>
	</ul>
<br /><hr />
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">

<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="var-title">
    <span class="var-type">mixed</span>
    <a href="#var$allowedLoginAttempts" title="details" class="property"><strong>$allowedLoginAttempts</strong></a>
</div>
<div class="var-title">
    <span class="var-type">mixed</span>
    <a href="#var$ANONYMOUS" title="details" class="property"><strong>$ANONYMOUS</strong></a>
</div>
<div class="var-title">
    <span class="var-type">mixed</span>
    <a href="#var$sessionAbsoluteTimeout" title="details" class="property"><strong>$sessionAbsoluteTimeout</strong></a>
</div>
<div class="var-title">
    <span class="var-type">mixed</span>
    <a href="#var$sessionTimeout" title="details" class="property"><strong>$sessionTimeout</strong></a>
</div>
<hr />
<a name="var$allowedLoginAttempts" id="var$allowedLoginAttempts"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$allowedLoginAttempts =  3</strong> (line <span class="linenumber">38</span>)
 </h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
		<li><strong>access:</strong> - public</li>
	</ul>
</div>
<a name="var$ANONYMOUS" id="var$ANONYMOUS"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$ANONYMOUS =  null</strong> (line <span class="linenumber">757</span>)
 </h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>The ANONYMOUS user is used to represent an unidentified user. Since there is  always a real user, the ANONYMOUS user is better than using null to represent  this.</h5>
<ul>
		<li><strong>access:</strong> - public</li>
	</ul>
</div>
<a name="var$sessionAbsoluteTimeout" id="var$sessionAbsoluteTimeout"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$sessionAbsoluteTimeout =  7200</strong> (line <span class="linenumber">40</span>)
 </h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
		<li><strong>access:</strong> - public</li>
	</ul>
</div>
<a name="var$sessionTimeout" id="var$sessionTimeout"><!-- --></A>
<div style="background='#ffffff'">
<h4>
<img src="../media/images/PublicProperty.gif" border="0" /> <strong class="property">$sessionTimeout =  3600</strong> (line <span class="linenumber">39</span>)
 </h4>
<h4>Data type : mixed</h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
		<li><strong>access:</strong> - public</li>
	</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">

<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="const-title">
    <a href="#constMAX_ROLE_LENGTH" title="details" class="property"><strong>MAX_ROLE_LENGTH</strong></a>
</div>
<hr />
<a name="constMAX_ROLE_LENGTH" id="constMAX_ROLE_LENGTH"><!-- --></A>
<div style="background='#eeeeee'">
<h4>
<img src="../media/images/Constant.gif" border="0" /> <strong class="property">MAX_ROLE_LENGTH =  250</strong> (line <span class="linenumber">100</span>)
 </h4>
<!-- ========== Info from phpDoc block ========= -->
<ul>
	</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
    <div class="method-definition">
            <span class="method-result">DefaultUser</span>
        <a href="#method__construct" title="details" class="method-name">__construct</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$accountName</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#method__destruct" title="details" class="method-name">__destruct</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodaddRole" title="details" class="method-name">addRole</a>
        (<span class="var-type">role</span>&nbsp;<span class="var-name">$role</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodaddRoles" title="details" class="method-name">addRoles</a>
        (<span class="var-type">Array</span>&nbsp;<span class="var-name">$newRoles</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodaddSession" title="details" class="method-name">addSession</a>
        ([<span class="var-type">$HttpSession</span>&nbsp;<span class="var-name">$HttpSession</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodchangePassword" title="details" class="method-name">changePassword</a>
        (<span class="var-type">oldPassword</span>&nbsp;<span class="var-name">$oldPassword</span>, <span class="var-type">newPassword1</span>&nbsp;<span class="var-name">$newPassword1</span>, <span class="var-type">newPassword2</span>&nbsp;<span class="var-name">$newPassword2</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methoddisable" title="details" class="method-name">disable</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodenable" title="details" class="method-name">enable</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">Integer</span>
        <a href="#methodgetAccountId" title="details" class="method-name">getAccountId</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">the</span>
        <a href="#methodgetAccountName" title="details" class="method-name">getAccountName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">String</span>
        <a href="#methodgetCSRFToken" title="details" class="method-name">getCSRFToken</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">Date</span>
        <a href="#methodgetExpirationTime" title="details" class="method-name">getExpirationTime</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">Integer</span>
        <a href="#methodgetFailedLoginCount" title="details" class="method-name">getFailedLoginCount</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">date</span>
        <a href="#methodgetLastFailedLoginTime" title="details" class="method-name">getLastFailedLoginTime</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">String</span>
        <a href="#methodgetLastHostAddress" title="details" class="method-name">getLastHostAddress</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">date</span>
        <a href="#methodgetLastLoginTime" title="details" class="method-name">getLastLoginTime</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">the</span>
        <a href="#methodgetLastPasswordChangeTime" title="details" class="method-name">getLastPasswordChangeTime</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">Array</span>
        <a href="#methodgetRoles" title="details" class="method-name">getRoles</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">String</span>
        <a href="#methodgetScreenName" title="details" class="method-name">getScreenName</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">Array</span>
        <a href="#methodgetSessions" title="details" class="method-name">getSessions</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">String</span>
        <a href="#methodhashPassword" title="details" class="method-name">hashPassword</a>
        (<span class="var-type">String</span>&nbsp;<span class="var-name">$Password</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodincrementFailedLoginCount" title="details" class="method-name">incrementFailedLoginCount</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">true,</span>
        <a href="#methodisAnonymous" title="details" class="method-name">isAnonymous</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">true,</span>
        <a href="#methodisEnabled" title="details" class="method-name">isEnabled</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">true,</span>
        <a href="#methodisExpired" title="details" class="method-name">isExpired</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">true,</span>
        <a href="#methodisInRole" title="details" class="method-name">isInRole</a>
        (<span class="var-type">String</span>&nbsp;<span class="var-name">$role</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">true,</span>
        <a href="#methodisLocked" title="details" class="method-name">isLocked</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">true,</span>
        <a href="#methodisLoggedIn" title="details" class="method-name">isLoggedIn</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">true,</span>
        <a href="#methodisSessionAbsoluteTimeout" title="details" class="method-name">isSessionAbsoluteTimeout</a>
        ([<span class="var-type">String</span>&nbsp;<span class="var-name">$HttpSession</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">true,</span>
        <a href="#methodisSessionTimeout" title="details" class="method-name">isSessionTimeout</a>
        ([<span class="var-type">String</span>&nbsp;<span class="var-name">$HttpSession</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodlock" title="details" class="method-name">lock</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodloginWithPassword" title="details" class="method-name">loginWithPassword</a>
        (<span class="var-type">String</span>&nbsp;<span class="var-name">$password</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodlogout" title="details" class="method-name">logout</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodremoveRole" title="details" class="method-name">removeRole</a>
        (<span class="var-type">String</span>&nbsp;<span class="var-name">$role</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodremoveSession" title="details" class="method-name">removeSession</a>
        ([<span class="var-type">$HttpSession</span>&nbsp;<span class="var-name">$HttpSession</span> = <span class="var-default">null</span>])
        </div>
    <div class="method-definition">
            <span class="method-result">the</span>
        <a href="#methodresetCSRFToken" title="details" class="method-name">resetCSRFToken</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">unknown_type</span>
        <a href="#methodsetAccountID" title="details" class="method-name">setAccountID</a>
        (<span class="var-type">integer</span>&nbsp;<span class="var-name">$accountId</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetAccountName" title="details" class="method-name">setAccountName</a>
        (<span class="var-type">String</span>&nbsp;<span class="var-name">$accountName</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetExpirationTime" title="details" class="method-name">setExpirationTime</a>
        (<span class="var-type">$ExpirationTime</span>&nbsp;<span class="var-name">$ExpirationTime</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetFailedLoginCount" title="details" class="method-name">setFailedLoginCount</a>
        (<span class="var-type"></span>&nbsp;<span class="var-name">$count</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetLastFailedLoginTime" title="details" class="method-name">setLastFailedLoginTime</a>
        (<span class="var-type">Integer</span>&nbsp;<span class="var-name">$LastFailedLoginTime</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetLastHostAddress" title="details" class="method-name">setLastHostAddress</a>
        (<span class="var-type">$remoteHost</span>&nbsp;<span class="var-name">$RemoteHost</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetLastLoginTime" title="details" class="method-name">setLastLoginTime</a>
        (<span class="var-type">Integer</span>&nbsp;<span class="var-name">$LastLoginTime</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetLastPasswordChangeTime" title="details" class="method-name">setLastPasswordChangeTime</a>
        (<span class="var-type">Integer</span>&nbsp;<span class="var-name">$LastPasswordChangeTime</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetRoles" title="details" class="method-name">setRoles</a>
        (<span class="var-type">Array</span>&nbsp;<span class="var-name">$Roles</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodsetScreenName" title="details" class="method-name">setScreenName</a>
        (<span class="var-type">String</span>&nbsp;<span class="var-name">$screenName</span>)
        </div>
    <div class="method-definition">
            <span class="method-result">void</span>
        <a href="#methodunlock" title="details" class="method-name">unlock</a>
        ()
        </div>
    <div class="method-definition">
            <span class="method-result">true,</span>
        <a href="#methodverifyPassword" title="details" class="method-name">verifyPassword</a>
        (<span class="var-type">$password</span>&nbsp;<span class="var-name">$password</span>)
        </div>
</div>
<hr />
<A NAME='method_detail'></A>


<a name="method__construct" id="method__construct"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/Constructor.gif" border="0" /> <strong class="method">Constructor __construct</strong> (line <span class="linenumber">103</span>)
 </h4> 
<h4><i>DefaultUser</i> <strong>__construct(

$accountName)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $accountName</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="method__destruct" id="method__destruct"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/Destructor.gif" border="0" /> <strong class="method">Destructor __destruct</strong> (line <span class="linenumber">120</span>)
 </h4> 
<h4><i>void</i> <strong>__destruct(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodaddRole" id="methodaddRole"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method addRole</strong> (line <span class="linenumber">210</span>)
 </h4> 
<h4><i>void</i> <strong>addRole(
role
$role)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Adds a role to this user's account.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>role $role</strong>: the role to add</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>throws</strong> - AuthenticationException          the authentication exception</li>
		</ul>
</div>
<a name="methodaddRoles" id="methodaddRoles"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method addRoles</strong> (line <span class="linenumber">231</span>)
 </h4> 
<h4><i>void</i> <strong>addRoles(
Array
$newRoles)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Adds a set of roles to this user's account.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>Array $newRoles</strong>: the new roles to add</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>throws</strong> - AuthenticationException          the authentication exception</li>
		</ul>
</div>
<a name="methodaddSession" id="methodaddSession"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method addSession</strong> (line <span class="linenumber">375</span>)
 </h4> 
<h4><i>void</i> <strong>addSession(
[$HttpSession
$HttpSession = null])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Adds a session for this User.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>$HttpSession $HttpSession</strong>: string sessionID</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodchangePassword" id="methodchangePassword"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method changePassword</strong> (line <span class="linenumber">250</span>)
 </h4> 
<h4><i>void</i> <strong>changePassword(
oldPassword
$oldPassword, newPassword1
$newPassword1, newPassword2
$newPassword2)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Sets the user's password, performing a verification of the user's old password, the equality of the two new  passwords, and the strength of the new password.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>oldPassword $oldPassword</strong>: the old password</li>
			<li><strong>newPassword1 $newPassword1</strong>: the new password</li>
			<li><strong>newPassword2 $newPassword2</strong>: the new password - used to verify that the new password was typed correctly</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>throws</strong> - AuthenticationException          if newPassword1 does not match newPassword2, if oldPassword does not match the stored old password, or if the new password does not meet complexity requirements</li>
			<li><strong>throws</strong> - EncryptionException</li>
		</ul>
</div>
<a name="methoddisable" id="methoddisable"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method disable</strong> (line <span class="linenumber">257</span>)
 </h4> 
<h4><i>void</i> <strong>disable(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Disable this user's account.</h5>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodenable" id="methodenable"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method enable</strong> (line <span class="linenumber">264</span>)
 </h4> 
<h4><i>void</i> <strong>enable(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Enable this user's account.</h5>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodgetAccountId" id="methodgetAccountId"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAccountId</strong> (line <span class="linenumber">274</span>)
 </h4> 
<h4><i>Integer</i> <strong>getAccountId(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets this user's account id number.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the account id</li>
		</ul>
</div>
<a name="methodgetAccountName" id="methodgetAccountName"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAccountName</strong> (line <span class="linenumber">196</span>)
 </h4> 
<h4><i>the</i> <strong>getAccountName(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets this user's account name.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - account name</li>
		</ul>
</div>
<a name="methodgetCSRFToken" id="methodgetCSRFToken"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getCSRFToken</strong> (line <span class="linenumber">282</span>)
 </h4> 
<h4><i>String</i> <strong>getCSRFToken(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the CSRF token for this user's current sessions.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the CSRF token</li>
		</ul>
</div>
<a name="methodgetExpirationTime" id="methodgetExpirationTime"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getExpirationTime</strong> (line <span class="linenumber">290</span>)
 </h4> 
<h4><i>Date</i> <strong>getExpirationTime(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns the date that this user's account will expire.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - representing the account expiration time.</li>
		</ul>
</div>
<a name="methodgetFailedLoginCount" id="methodgetFailedLoginCount"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getFailedLoginCount</strong> (line <span class="linenumber">302</span>)
 </h4> 
<h4><i>Integer</i> <strong>getFailedLoginCount(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns the number of failed login attempts since the last successful login for an account. This method is  intended to be used as a part of the account lockout feature, to help protect against brute force attacks.</h5>
<div class="desc"><p>However, the implementor should be aware that lockouts can be used to prevent access to an application by a  legitimate user, and should consider the risk of denial of service.</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the number of failed login attempts since the last successful login</li>
		</ul>
</div>
<a name="methodgetLastFailedLoginTime" id="methodgetLastFailedLoginTime"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLastFailedLoginTime</strong> (line <span class="linenumber">329</span>)
 </h4> 
<h4><i>date</i> <strong>getLastFailedLoginTime(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns the date of the last failed login time for a user. This date should be used in a message to users after a  successful login, to notify them of potential attack activity on their account.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - of the last failed login</li>
			<li><strong>throws</strong> - AuthenticationException          the authentication exception</li>
		</ul>
</div>
<a name="methodgetLastHostAddress" id="methodgetLastHostAddress"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLastHostAddress</strong> (line <span class="linenumber">312</span>)
 </h4> 
<h4><i>String</i> <strong>getLastHostAddress(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns the last host address used by the user. This will be used in any log messages generated by the processing  of this request.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the last host address used by the user</li>
		</ul>
</div>
<a name="methodgetLastLoginTime" id="methodgetLastLoginTime"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLastLoginTime</strong> (line <span class="linenumber">339</span>)
 </h4> 
<h4><i>date</i> <strong>getLastLoginTime(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns the date of the last successful login time for a user. This date should be used in a message to users  after a successful login, to notify them of potential attack activity on their account.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - of the last successful login</li>
		</ul>
</div>
<a name="methodgetLastPasswordChangeTime" id="methodgetLastPasswordChangeTime"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getLastPasswordChangeTime</strong> (line <span class="linenumber">348</span>)
 </h4> 
<h4><i>the</i> <strong>getLastPasswordChangeTime(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the date of user's last password change.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - date of last password change</li>
		</ul>
</div>
<a name="methodgetRoles" id="methodgetRoles"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getRoles</strong> (line <span class="linenumber">357</span>)
 </h4> 
<h4><i>Array</i> <strong>getRoles(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the roles assigned to a particular account.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - an immutable set of roles</li>
		</ul>
</div>
<a name="methodgetScreenName" id="methodgetScreenName"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getScreenName</strong> (line <span class="linenumber">366</span>)
 </h4> 
<h4><i>String</i> <strong>getScreenName(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Gets the screen name (alias) for the current user.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the screen name</li>
		</ul>
</div>
<a name="methodgetSessions" id="methodgetSessions"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getSessions</strong> (line <span class="linenumber">396</span>)
 </h4> 
<h4><i>Array</i> <strong>getSessions(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns the list of sessions associated with this User.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - sessions</li>
		</ul>
</div>
<a name="methodhashPassword" id="methodhashPassword"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method hashPassword</strong> (line <span class="linenumber">129</span>)
 </h4> 
<h4><i>String</i> <strong>hashPassword(
String
$Password)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>This is intended to compute the password hash for a password</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>String $Password</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - the hash</li>
		</ul>
</div>
<a name="methodincrementFailedLoginCount" id="methodincrementFailedLoginCount"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method incrementFailedLoginCount</strong> (line <span class="linenumber">403</span>)
 </h4> 
<h4><i>void</i> <strong>incrementFailedLoginCount(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Increment failed login count.</h5>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodisAnonymous" id="methodisAnonymous"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isAnonymous</strong> (line <span class="linenumber">420</span>)
 </h4> 
<h4><i>true,</i> <strong>isAnonymous(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Checks if user is anonymous.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - if user is anonymous</li>
		</ul>
</div>
<a name="methodisEnabled" id="methodisEnabled"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isEnabled</strong> (line <span class="linenumber">434</span>)
 </h4> 
<h4><i>true,</i> <strong>isEnabled(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Checks if this user's account is currently enabled.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - if account is enabled</li>
		</ul>
</div>
<a name="methodisExpired" id="methodisExpired"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isExpired</strong> (line <span class="linenumber">442</span>)
 </h4> 
<h4><i>true,</i> <strong>isExpired(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Checks if this user's account is expired.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - if account is expired</li>
		</ul>
</div>
<a name="methodisInRole" id="methodisInRole"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isInRole</strong> (line <span class="linenumber">458</span>)
 </h4> 
<h4><i>true,</i> <strong>isInRole(
String
$role)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Checks if this user's account is assigned a particular role.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>String $role</strong>: the role for which to check</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - if role has been assigned to user</li>
		</ul>
</div>
<a name="methodisLocked" id="methodisLocked"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isLocked</strong> (line <span class="linenumber">467</span>)
 </h4> 
<h4><i>true,</i> <strong>isLocked(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Checks if this user's account is locked.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - if account is locked</li>
		</ul>
</div>
<a name="methodisLoggedIn" id="methodisLoggedIn"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isLoggedIn</strong> (line <span class="linenumber">475</span>)
 </h4> 
<h4><i>true,</i> <strong>isLoggedIn(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Tests to see if the user is currently logged in.</h5>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - if the user is logged in</li>
		</ul>
</div>
<a name="methodisSessionAbsoluteTimeout" id="methodisSessionAbsoluteTimeout"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isSessionAbsoluteTimeout</strong> (line <span class="linenumber">486</span>)
 </h4> 
<h4><i>true,</i> <strong>isSessionAbsoluteTimeout(
[String
$HttpSession = null])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Tests to see if this user's session has exceeded the absolute time out based  on ESAPI's configuration settings.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>String $HttpSession</strong>: optional session id</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - if user's session has exceeded the absolute time out</li>
		</ul>
</div>
<a name="methodisSessionTimeout" id="methodisSessionTimeout"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method isSessionTimeout</strong> (line <span class="linenumber">510</span>)
 </h4> 
<h4><i>true,</i> <strong>isSessionTimeout(
[String
$HttpSession = null])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Tests to see if the user's session has timed out from inactivity based  on ESAPI's configuration settings.</h5>
<div class="desc"><p>A session may timeout prior to ESAPI's configuration setting due to  the servlet container setting for session-timeout in web.xml. The  following is an example of a web.xml session-timeout set for one hour.</p><p>&lt;session-config&gt;    &lt;session-timeout&gt;60&lt;/session-timeout&gt;  &lt;/session-config&gt;</p></div>
		<h4>Parameters</h4>
	<ul>
			<li><strong>String $HttpSession</strong>: optional session id</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - if user's session has timed out from inactivity based                on ESAPI configuration</li>
		</ul>
</div>
<a name="methodlock" id="methodlock"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method lock</strong> (line <span class="linenumber">523</span>)
 </h4> 
<h4><i>void</i> <strong>lock(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Lock this user's account.</h5>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodloginWithPassword" id="methodloginWithPassword"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method loginWithPassword</strong> (line <span class="linenumber">535</span>)
 </h4> 
<h4><i>void</i> <strong>loginWithPassword(
String
$password)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Login with password.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>String $password</strong>: the password</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>throws</strong> - AuthenticationException          if login fails</li>
		</ul>
</div>
<a name="methodlogout" id="methodlogout"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method logout</strong> (line <span class="linenumber">585</span>)
 </h4> 
<h4><i>void</i> <strong>logout(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Logout this user.</h5>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodremoveRole" id="methodremoveRole"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method removeRole</strong> (line <span class="linenumber">604</span>)
 </h4> 
<h4><i>void</i> <strong>removeRole(
String
$role)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Removes a role from this user's account.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>String $role</strong>: the role to remove</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>throws</strong> - AuthenticationException          the authentication exception</li>
		</ul>
</div>
<a name="methodremoveSession" id="methodremoveSession"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method removeSession</strong> (line <span class="linenumber">387</span>)
 </h4> 
<h4><i>void</i> <strong>removeSession(
[$HttpSession
$HttpSession = null])</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Removes a session for this User.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>$HttpSession $HttpSession</strong>: string session id</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodresetCSRFToken" id="methodresetCSRFToken"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method resetCSRFToken</strong> (line <span class="linenumber">621</span>)
 </h4> 
<h4><i>the</i> <strong>resetCSRFToken(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Returns a token to be used as a prevention against CSRF attacks. This token should be added to all links and  forms. The application should verify that all requests contain the token, or they may have been generated by a  CSRF attack. It is generally best to perform the check in a centralized location, either a filter or controller.</h5>
<div class="desc"><p>See the verifyCSRFToken method.</p></div>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - new CSRF token</li>
			<li><strong>throws</strong> - AuthenticationException          the authentication exception</li>
		</ul>
</div>
<a name="methodsetAccountID" id="methodsetAccountID"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setAccountID</strong> (line <span class="linenumber">645</span>)
 </h4> 
<h4><i>unknown_type</i> <strong>setAccountID(
integer
$accountId)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Sets this user's account ID</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>integer $accountId</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetAccountName" id="methodsetAccountName"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setAccountName</strong> (line <span class="linenumber">633</span>)
 </h4> 
<h4><i>void</i> <strong>setAccountName(
String
$accountName)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Sets this user's account name.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>String $accountName</strong>: the new account name</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetExpirationTime" id="methodsetExpirationTime"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setExpirationTime</strong> (line <span class="linenumber">654</span>)
 </h4> 
<h4><i>void</i> <strong>setExpirationTime(
$ExpirationTime
$ExpirationTime)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Sets the date and time when this user's account will expire.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>$ExpirationTime $ExpirationTime</strong>: Timestamp the new expiration time</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetFailedLoginCount" id="methodsetFailedLoginCount"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setFailedLoginCount</strong> (line <span class="linenumber">407</span>)
 </h4> 
<h4><i>void</i> <strong>setFailedLoginCount(

$count)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $count</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetLastFailedLoginTime" id="methodsetLastFailedLoginTime"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setLastFailedLoginTime</strong> (line <span class="linenumber">711</span>)
 </h4> 
<h4><i>void</i> <strong>setLastFailedLoginTime(
Integer
$LastFailedLoginTime)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Set the time of the last failed login for this user.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>Integer $LastFailedLoginTime</strong>: Timestamp the date and time when the user just failed to login correctly.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetLastHostAddress" id="methodsetLastHostAddress"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setLastHostAddress</strong> (line <span class="linenumber">721</span>)
 </h4> 
<h4><i>void</i> <strong>setLastHostAddress(
$remoteHost
$RemoteHost)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Set the last remote host address used by this user.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>$remoteHost $RemoteHost</strong>: The address of the user's current source host.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetLastLoginTime" id="methodsetLastLoginTime"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setLastLoginTime</strong> (line <span class="linenumber">736</span>)
 </h4> 
<h4><i>void</i> <strong>setLastLoginTime(
Integer
$LastLoginTime)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Set the time of the last successful login for this user.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>Integer $LastLoginTime</strong>: Timestamp the date and time when the user just successfully logged in.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetLastPasswordChangeTime" id="methodsetLastPasswordChangeTime"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setLastPasswordChangeTime</strong> (line <span class="linenumber">746</span>)
 </h4> 
<h4><i>void</i> <strong>setLastPasswordChangeTime(
Integer
$LastPasswordChangeTime)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Set the time of the last password change for this user.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>Integer $LastPasswordChangeTime</strong>: Timestamp the date and time when the user just successfully changed his/her password.</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodsetRoles" id="methodsetRoles"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setRoles</strong> (line <span class="linenumber">668</span>)
 </h4> 
<h4><i>void</i> <strong>setRoles(
Array
$Roles)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Sets the roles for this account.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>Array $Roles</strong>: the new roles</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>throws</strong> - AuthenticationException          the authentication exception</li>
		</ul>
</div>
<a name="methodsetScreenName" id="methodsetScreenName"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setScreenName</strong> (line <span class="linenumber">678</span>)
 </h4> 
<h4><i>void</i> <strong>setScreenName(
String
$screenName)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Sets the screen name (username alias) for this user.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>String $screenName</strong>: the new screen name</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodunlock" id="methodunlock"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method unlock</strong> (line <span class="linenumber">686</span>)
 </h4> 
<h4><i>void</i> <strong>unlock(
)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Unlock this user's account.</h5>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="methodverifyPassword" id="methodverifyPassword"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method verifyPassword</strong> (line <span class="linenumber">702</span>)
 </h4> 
<h4><i>true,</i> <strong>verifyPassword(
$password
$password)</strong></h4>

	<!-- ========== Info from phpDoc block ========= -->
<h5>Verify that the supplied password matches the password for this user. This method  is typically used for &quot;reauthentication&quot; for the most sensitive functions, such  as transactions, changing email address, and changing other account information.</h5>
		<h4>Parameters</h4>
	<ul>
			<li><strong>$password $password</strong>: the password that the user entered</li>
		</ul>
		
	<h4>Info</h4>
	<ul>
			<li><strong>return</strong> - if the password passed in matches the account's password</li>
			<li><strong>throws</strong> - EncryptionException</li>
			<li><strong>access</strong> - public</li>
		</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script></div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>

	</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>

	</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Fri, 21 May 2010 14:53:34 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</div>
</body>
</html>